org.springframework.web.socket

Class TextMessage

java.lang.Object

org.springframework.web.socket.AbstractWebSocketMessage<java.lang.String>

org.springframework.web.socket.TextMessage

All Implemented Interfaces:

WebSocketMessage<java.lang.String>

public final class TextMessage
extends AbstractWebSocketMessage<java.lang.String>

A text WebSocket message.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	bytes
private static java.nio.charset.Charset	UTF8_CHARSET

Constructor Summary

Constructors

Constructor and Description
TextMessage(byte[] payload) Create a new text WebSocket message from the given byte[].
TextMessage(java.lang.CharSequence payload) Create a new text WebSocket message from the given CharSequence payload.
TextMessage(java.lang.CharSequence payload, boolean isLast) Create a new text WebSocket message with the given payload representing the full or partial message content.

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes()
int	getPayloadLength() Return the number of bytes contained in the message.
protected java.lang.String	toStringPayload()

Methods inherited from class org.springframework.web.socket.AbstractWebSocketMessage

equals, getPayload, hashCode, isLast, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UTF8_CHARSET

private static final java.nio.charset.Charset UTF8_CHARSET

bytes

private final byte[] bytes

Constructor Detail

TextMessage

public TextMessage(java.lang.CharSequence payload)

Create a new text WebSocket message from the given CharSequence payload.

Parameters:

payload - the non-null payload

TextMessage

public TextMessage(byte[] payload)

Create a new text WebSocket message from the given byte[]. It is assumed the byte array can be encoded into an UTF-8 String.

Parameters:

payload - the non-null payload

TextMessage

public TextMessage(java.lang.CharSequence payload,
                   boolean isLast)

Create a new text WebSocket message with the given payload representing the full or partial message content. When the isLast boolean flag is set to false the message is sent as partial content and more partial messages will be expected until the boolean flag is set to true.

Parameters:

payload - the non-null payload

isLast - whether this the last part of a series of partial messages

Method Detail

getPayloadLength

public int getPayloadLength()

Description copied from interface: WebSocketMessage

Return the number of bytes contained in the message.

asBytes

public byte[] asBytes()

toStringPayload

protected java.lang.String toStringPayload()

Specified by:

toStringPayload in class AbstractWebSocketMessage<java.lang.String>